NavigateHome Method, SftTree Class


	NavigateHome Method, SftTree Class	Softel vdm, Inc.

Navigates to the very first item or cell in the control.

Syntax SftTree Class (Softelvdm.SftTreeNET)

VB	Public Function NavigateHome( _ ByVal fSelect As Boolean, _ ByVal fSelectCumulative As Boolean _ ) As Object
C#	public object NavigateHome( bool fSelect, bool fSelectCumulative );
C++	public: Object^ NavigateHome( bool fSelect, bool fSelectCumulative );

fSelect

Defines whether the item or cell found is automatically selected, True to select, otherwise False.

fSelectCumulative

Defines whether the selection is cumulative. True if the selection is cumulative, otherwise False. This parameter is ignored if fSelect is False and can only be used with when multiple item or multiple cell selection is active (SelectionStyle).

Return Value

The item or cell.

Comments

The NavigateHome method navigates to the very first item or cell in the control.

Given a starting item or cell, this method returns the first item or cell in the control that can be selected. It considers cell merging and the selectable area (SelectableArea).

If fSelect is True to automatically select the new item or cell, the specified StartObject, an item or cell, must match the current selection style (SelectionStyle).

If the StartObject parameter is null/Nothing and the FocusObject property is null/Nothing, the method returns null/Nothing.